vcSelectProductsStatement

Statement that filters product types from a given list variable to a new list variable.

See in: Overview

Module: vcProcessModel

Parent: vcStatement

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
FiltervcProductFilterRGets the filter.
MaxCountPropertyvcExpressionPropertyRGets an expression property that defines the maximum number of accepted products.
ProductVariableNameStringRWGets or sets the name of the input list variable to filter from.
SplitVariableNameStringRWGets or sets the name of the output list variable to filter to. This variable will be created if it does not already exist.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
demoteFromCombinationFiltervcProductFilterNoneDowngrades back to filter, filter count must have 1 or 0 filters.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is not a CombinationFilter.
TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFiltervcProductFilterNoneUpgrades current filter to combination filter.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is already a CombinationFilter.
replaceFromvcProductFiltervcStatement statementSets filter from other container.
See more
Parameters:
statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container.

Returns:
vcProductFilter: The modified filter.

Exceptions:
AttributeError: When argument is a statement without a filter container.
setFiltervcProductFiltervcProductFilterType filterTypeSets to specific filter.
See more
Parameters:
filterType (vcProductFilterType): The type of filter to set to.

Returns:
vcProductFilter: The new filter.

Exceptions:
AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnFilterChangedNoneTriggered when filter is changed.